Update and improve .pre-commit-config.yaml
#748
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phklive
requested review from
bobbinth and
igamigo
and removed request for
bobbinth
bobbinth
reviewed
Jun 12, 2024
README.md
Outdated
Comment on lines
73
to
75
| ## Commiting | ||
|
|
||
| To make sure all commits adhere to our programming standards we use [pre-commit](https://pre-commit.com/) ([file](.pre-commit-config.yaml)) to run automatic commands on each commit. Please install it and follow the setup instructions for your machine. |
There was a problem hiding this comment.
Should this go into the CONTRIBUTING file?
There was a problem hiding this comment.
Indeed we can move it there.
bobbinth
reviewed
Jun 12, 2024
Makefile
Outdated
Comment on lines
67
to
68
| check: ## Check all targets and features | ||
| cargo check --all-targets $(ALL_FEATURES_BUT_ASYNC) |
There was a problem hiding this comment.
I would make the comment a bit more informative. Maybe something like "Check all targets and features for errors without code generation"
bobbinth
force-pushed
the
phklive-pre-commit-config
branch
from
f6882d1 to
484ab51
Compare
|
@bobbinth just to understand, why did you force push? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR I propose to update and improve the
.pre-commit-config.yamlfile that we use in our repo.I have also added documentation and made sure that it uses our Makefile commands.
Closes: #537
based on #746